Esx Settings Depots AffectedDesiredStateInfo

Esx Settings Depots AffectedDesiredStateInfo
Esx Settings Depots AffectedDesiredStateInfo

The Esx Settings Depots AffectedDesiredStateInfo schema contains the fields that describe which release units in the desired state will be affected by the depot to be deleted or disabled.

This schema was added in vSphere API 7.0.3.0.

JSON Example
{
    "cluster_name": "string",
    "cluster_id": "string",
    "entity_name": "string",
    "entity_id": "string",
    "software_spec_name": "string",
    "software_spec": "string",
    "entity_names": [
        "string"
    ],
    "entities": [
        "string"
    ],
    "affected_base_image": {
        "version": "string",
        "display_name": "string",
        "display_version": "string"
    },
    "affected_addon": {
        "affected_addon": {
            "display_name": "string",
            "vendor": "string",
            "versions": [
                {
                    "version": "string",
                    "display_version": "string"
                }
            ]
        }
    },
    "affected_solutions": {
        "affected_solutions": {
            "display_name": "string",
            "versions": [
                {
                    "version": "string",
                    "display_version": "string"
                }
            ],
            "components": {
                "components": {
                    "release_date": "string",
                    "version": {
                        "version": "string",
                        "display_version": "string"
                    },
                    "vib_informations": {
                        "vib_informations": {
                            "software_tags": [
                                "string"
                            ]
                        }
                    }
                }
            }
        }
    },
    "affected_hardware_support": {
        "affected_hardware_support": {
            "display_name": "string",
            "packages": {
                "packages": {
                    "versions": [
                        {
                            "version": "string"
                        }
                    ]
                }
            }
        }
    },
    "affected_independent_components": {
        "affected_independent_components": {
            "display_name": "string",
            "versions": [
                {
                    "version": "string",
                    "display_version": "string"
                }
            ]
        }
    }
}
string
cluster_name
Required

This property is deprecated as of vSphere API 8.0.0.1.

Since now we have standalone host, we use {#member entityName} {#member entityId} to better describe name/id of either cluster or standalone host.

Name of the cluster the affected desired state belongs to.

@deprecated Use {#member entityName} instead

This property was added in vSphere API 7.0.3.0.

string
cluster_id
Required

This property is deprecated as of vSphere API 8.0.0.1. Use {#member entityId} instead

Identifier of the cluster the affected desired state belongs to.

This property was added in vSphere API 7.0.3.0.

When clients pass a value of this schema as a parameter, the property must be an identifier for the resource type: ClusterComputeResource. When operations return a value of this schema as a response, the property will be an identifier for the resource type: ClusterComputeResource.

string
entity_name
Optional

This property is deprecated as of vSphere API 9.0.0.0.

Name of the entity the affected desired state belongs to.

This property was added in vSphere API 8.0.0.1.

This property is optional because it was added in a newer version than its parent node.

string
entity_id
Optional

This property is deprecated as of vSphere API 9.0.0.0.

Identifier of the entity the affected desired state belongs to.

This property was added in vSphere API 8.0.0.1.

This property is optional because it was added in a newer version than its parent node.

When clients pass a value of this schema as a parameter, the property must be an identifier for the resource type: ManagedEntity. When operations return a value of this schema as a response, the property will be an identifier for the resource type: ManagedEntity.

string
software_spec_name
Optional

Name of the affected software specification.

This property was added in vSphere API 9.0.0.0.

This property is optional because it was added in a newer version than its parent node.

string
software_spec
Optional

Identifier of the affected software specification.

This property was added in vSphere API 9.0.0.0.

This property is optional because it was added in a newer version than its parent node.

When clients pass a value of this schema as a parameter, the property must be an identifier for the resource type: com.vmware.esx.settings.repository.software_spec. When operations return a value of this schema as a response, the property will be an identifier for the resource type: com.vmware.esx.settings.repository.software_spec.

array of string
entity_names
Optional

Names of the entities the affected software specification associates with.

This property was added in vSphere API 9.0.0.0.

This property is optional because it was added in a newer version than its parent node.

array of string
entities
Optional

Identifiers of the entities the affected software specification associates with.

This property was added in vSphere API 9.0.0.0.

This property is optional because it was added in a newer version than its parent node.

When clients pass a value of this schema as a parameter, the property must contain identifiers for the resource type: ManagedEntity. When operations return a value of this schema as a response, the property will contain identifiers for the resource type: ManagedEntity.

affected_base_image
Optional

Affected base image of the desired state.

This property was added in vSphere API 7.0.3.0.

If missing or null, no base image of the desired state will be affected.

object
affected_addon
Optional

Affected addon of the desired state. The key is name of addon. Note: there is at most one addon affected.

This property was added in vSphere API 7.0.3.0.

If missing or null, no addon of the desired state will be affected.

When clients pass a value of this schema as a parameter, the key in the property map must be an identifier for the resource type: com.vmware.esx.settings.add_on. When operations return a value of this schema as a response, the key in the property map will be an identifier for the resource type: com.vmware.esx.settings.add_on.

object
affected_solutions
Optional

Affected solutions of the desired state. The key is name of solution.

This property was added in vSphere API 7.0.3.0.

If missing or null, no solution of the desired state will be affected.

When clients pass a value of this schema as a parameter, the key in the property map must be an identifier for the resource type: com.vmware.esx.settings.solution. When operations return a value of this schema as a response, the key in the property map will be an identifier for the resource type: com.vmware.esx.settings.solution.

object
affected_hardware_support
Optional

Affected hardware support of the desired state. The key is HSM name.

This property was added in vSphere API 7.0.3.0.

If missing or null, no hadrware support of the desired state will be affected.

When clients pass a value of this schema as a parameter, the key in the property map must be an identifier for the resource type: com.vmware.esx.setting.hardware_support.manager. When operations return a value of this schema as a response, the key in the property map will be an identifier for the resource type: com.vmware.esx.setting.hardware_support.manager.

object
affected_independent_components
Optional

Affected independent components of the desired state. The components belongs to other base images, addons, solutions and hardware support packages are not counted. The key is name of component.

This property was added in vSphere API 7.0.3.0.

If missing or null, no independent components of the desired state will be affected.

When clients pass a value of this schema as a parameter, the key in the property map must be an identifier for the resource type: com.vmware.esx.settings.component. When operations return a value of this schema as a response, the key in the property map will be an identifier for the resource type: com.vmware.esx.settings.component.

Property Of